﻿<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
<head>
	<link rel="Stylesheet" type="text/css" media="screen" href="Screen.css" />
  <title>STP_GetPortEnabled</title>
</head>
<body>
	<h3>STP_GetPortEnabled</h3>
	<hr />
<pre>
bool STP_GetPortEnabled
(
    BRIDGE*       bridge,
    unsigned int  portIndex
);
</pre>
	<h4>
		Summary</h4>
	<p>
		Reads the <code>portEnabled</code> variable (§13.25.31 in 802.1Q-2011).</p>
	<h4>
		Parameters</h4>
	<dl>
		<dt>bridge</dt>
		<dd>Pointer to a BRIDGE object, obtained from <a href="STP_CreateBridge.html">
			STP_CreateBridge</a>.</dd>
		<dt>portIndex</dt>
		<dd>The zero-based index of the port.</dd>
	</dl>
	<h4>
		Return value</h4>
		<dl>
		<dd>This function returns <code>true</code> if <a href="STP_OnPortEnabled.html">STP_OnPortEnabled</a> was called last.
			It returns <code>false</code> if <a href="STP_OnPortDisabled.html">STP_OnPortDisabled</a> was called last,
			or the bridge was just created with <a href="STP_CreateBridge.html">STP_CreateBridge</a>.</dd>
		</dl>
	<h4>
		Remarks</h4>
	<p>
			It is allowed to call this function from within an <a href="STP_CALLBACKS.html">STP callback</a>.</p>
</body>
</html>
